Skip to content

tdd and readme#71

Merged
ccapetz merged 2 commits into
carter-mrd-vizfrom
add-mrd-viz-tdd
Jun 23, 2026
Merged

tdd and readme#71
ccapetz merged 2 commits into
carter-mrd-vizfrom
add-mrd-viz-tdd

Conversation

@ccapetz

@ccapetz ccapetz commented Jun 17, 2026

Copy link
Copy Markdown
Collaborator

added a brief readme and detailed technical design doc in docs/TECHNICAL_DESIGN.md. requesting review for the TDD to make sure everything looks good and is aligned with expectations.

Comment thread mrd-viz/docs/TECHNICAL_DESIGN.md Outdated
Comment thread mrd-viz/docs/TECHNICAL_DESIGN.md Outdated
Comment thread mrd-viz/docs/TECHNICAL_DESIGN.md
Comment thread mrd-viz/docs/TECHNICAL_DESIGN.md Outdated
Comment thread mrd-viz/docs/TECHNICAL_DESIGN.md Outdated
```json
{
"ok": true,
"schema_version": 1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did not see a section about backwards compatibility (sorry if I missed it), but need to answer questions like: will the extension reject unknown schema versions? Will it attempt best-effort rendering?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also will explore this as i test around with more actual mrd files!

- MRD reader: uses `mrd-python` as the only Stage 1 format parser.
- Summary JSON: carries schema version, file class, display mode, header summary, stream counts, warnings, raw-only states, and error envelopes.
- Preview PNG data: uses base64 PNGs for bounded thumbnails and temporary PNG paths for lazy full-size image requests.
- Webview UI: renders the mosaic, selected image, metadata panel, loading states, unsupported states, and controlled errors.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what error views are we going to support? I.e. it would be nice to explicitly list the expected errors we may get (wrong version, wrong format, error in the way file is formatted...there are probably more)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will explore this as I test with more real-world mrd examples

Comment thread mrd-viz/docs/TECHNICAL_DESIGN.md Outdated
@yuliadub

Copy link
Copy Markdown
Collaborator

looks good - all the changes cover everything we talked about, thanks for including all that! a few follow up comments but nothing major. excited to try out a first version of the extension soon!

@ccapetz ccapetz changed the base branch from main to carter-mrd-viz June 18, 2026 22:01

@naegelejd naegelejd left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comprehensive! Good job scoping Stage 1 down to something manageable, with incremental improvements planned.

Comment thread mrd-viz/docs/TECHNICAL_DESIGN.md
… backward compatibility for unknown schema versions and what error views will be supported
@ccapetz ccapetz merged commit 8caf613 into carter-mrd-viz Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants